<!DOCTYPE HTML>
<html>
	<head>
		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
		<title>FPKOverlayViewDataSource Protocol Reference</title>
		<meta id="xcode-display" name="xcode-display" content="render"/>
		<meta name="viewport" content="width=550" />
		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
		<meta name="generator" content="appledoc 2.0.5 (build 748)" />
	</head>
	<body>
		<header id="top_header">
			<div id="library" class="hideInXcode">
				<h1><a id="libraryTitle" href="../index.html">FastPdfKit </a></h1>
				<a id="developerHome" href="../index.html">MobFarm</a>
			</div>
			
			<div id="title" role="banner">
				<h1 class="hideInXcode">FPKOverlayViewDataSource Protocol Reference</h1>
			</div>
			<ul id="headerButtons" role="toolbar">
				<li id="toc_button">
					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
				</li>
				<li id="jumpto_button" role="navigation">
					<select id="jumpTo">
	<option value="top">Jump To&#133;</option>
	
	
	
	
	<option value="tasks">Tasks</option>
	
	
	
	
	
	
	
	
	
	<option value="instance_methods">Instance Methods</option>
	
	<option value="//api/name/documentViewController:didAddOverlayView:">&nbsp;&nbsp;&nbsp;&nbsp;- documentViewController:didAddOverlayView:</option>
	
	<option value="//api/name/documentViewController:didRemoveOverlayView:">&nbsp;&nbsp;&nbsp;&nbsp;- documentViewController:didRemoveOverlayView:</option>
	
	<option value="//api/name/documentViewController:overlayViewsForPage:">&nbsp;&nbsp;&nbsp;&nbsp;- documentViewController:overlayViewsForPage:</option>
	
	<option value="//api/name/documentViewController:rectForOverlayView:onPage:">&nbsp;&nbsp;&nbsp;&nbsp;- documentViewController:rectForOverlayView:onPage:</option>
	
	<option value="//api/name/documentViewController:willAddOverlayView:">&nbsp;&nbsp;&nbsp;&nbsp;- documentViewController:willAddOverlayView:</option>
	
	<option value="//api/name/documentViewController:willRemoveOverlayView:">&nbsp;&nbsp;&nbsp;&nbsp;- documentViewController:willRemoveOverlayView:</option>
	
	
	
</select>
				</li>
			</ul>
		</header>
		<nav id="tocContainer" class="isShowingTOC">
			<ul id="toc" role="tree">
				



<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
	
</ul></li>









<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/documentViewController:didAddOverlayView:">documentViewController:didAddOverlayView:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/documentViewController:didRemoveOverlayView:">documentViewController:didRemoveOverlayView:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/documentViewController:overlayViewsForPage:">documentViewController:overlayViewsForPage:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/documentViewController:rectForOverlayView:onPage:">documentViewController:rectForOverlayView:onPage:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/documentViewController:willAddOverlayView:">documentViewController:willAddOverlayView:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/documentViewController:willRemoveOverlayView:">documentViewController:willRemoveOverlayView:</a></span></li>
	
</ul></li>


			</ul>
		</nav>
		<article>
			<div id="contents" class="isShowingTOC" role="main">
				<a title="FPKOverlayViewDataSource Protocol Reference" name="top"></a>
				<div class="main-navigation navigation-top">
					<ul>
	<li><a href="../index.html">Index</a></li>
	<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
				</div>
				<div id="header">
					<div class="section-header">
						<h1 class="title title-header">FPKOverlayViewDataSource Protocol Reference</h1>
					</div>		
				</div>
				<div id="container">	
					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<td class="specification-title">Conforms to</td>
	<td class="specification-value">NSObject</td>
</tr><tr>
	<td class="specification-title">Declared in</td>
	<td class="specification-value">FPKOverlayViewDataSource.h</td>
</tr>
						</tbody></table></div>
					
					
					
					
					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						<h2 class="subtitle subtitle-tasks">Tasks</h2>
						
						
						
						

						<ul class="task-list">
							<li>
	<span class="tooltip">
		<code><a href="#//api/name/documentViewController:overlayViewsForPage:">&ndash;&nbsp;documentViewController:overlayViewsForPage:</a></code>
		<span class="tooltip"><p>This method shall return a set of view to display over the pdf page.</p></span>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/documentViewController:rectForOverlayView:onPage:">&ndash;&nbsp;documentViewController:rectForOverlayView:onPage:</a></code>
		<span class="tooltip"><p>This method needs to return the frame in page-coordinates for the view passed as arguments. Remember that, like drawables
and touchables, the coordinate system&rsquo;s origin is in the bottom left corner of the page.</p></span>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/documentViewController:willAddOverlayView:">&ndash;&nbsp;documentViewController:willAddOverlayView:</a></code>
		<span class="tooltip"><p>These callbacks will be invoked when the overlay view is going to be added, after is added, when is going to be removed
and when it is actually removed from the page view. Use these to change the status of the view and or start/stop any
action that needs to be synchronized with the lifecycle of the view.</p></span>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/documentViewController:didAddOverlayView:">&ndash;&nbsp;documentViewController:didAddOverlayView:</a></code>
		<span class="tooltip"><p>This method is called when the Overlay Views have been added</p></span>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/documentViewController:willRemoveOverlayView:">&ndash;&nbsp;documentViewController:willRemoveOverlayView:</a></code>
		<span class="tooltip"><p>This method is called when the Overlay View are going to be removed</p></span>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/documentViewController:didRemoveOverlayView:">&ndash;&nbsp;documentViewController:didRemoveOverlayView:</a></code>
		<span class="tooltip"><p>This method is called when the Overlay View have been removed</p></span>
	</span>
	
	
</li>
						</ul>
						
					</div>
					
					
					
					
					
					
					
					
					
					<div class="section section-methods">
						<a title="Instance Methods" name="instance_methods"></a>
						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
						
						<div class="section-method">
	<a name="//api/name/documentViewController:didAddOverlayView:" title="documentViewController:didAddOverlayView:"></a>
	<h3 class="subsubtitle method-title">documentViewController:didAddOverlayView:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>This method is called when the Overlay Views have been added</p>
	</div>		
	
	
	<div class="method-subsection method-declaration"><code>- (void)documentViewController:(MFDocumentViewController *)<em>dvc</em> didAddOverlayView:(UIView *)<em>view</em></code></div>
	
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>This method is called when the Overlay Views have been added</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">FPKOverlayViewDataSource.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/documentViewController:didRemoveOverlayView:" title="documentViewController:didRemoveOverlayView:"></a>
	<h3 class="subsubtitle method-title">documentViewController:didRemoveOverlayView:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>This method is called when the Overlay View have been removed</p>
	</div>		
	
	
	<div class="method-subsection method-declaration"><code>- (void)documentViewController:(MFDocumentViewController *)<em>dvc</em> didRemoveOverlayView:(UIView *)<em>view</em></code></div>
	
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>This method is called when the Overlay View have been removed</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">FPKOverlayViewDataSource.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/documentViewController:overlayViewsForPage:" title="documentViewController:overlayViewsForPage:"></a>
	<h3 class="subsubtitle method-title">documentViewController:overlayViewsForPage:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>This method shall return a set of view to display over the pdf page.</p>
	</div>		
	
	
	<div class="method-subsection method-declaration"><code>- (NSArray *)documentViewController:(MFDocumentViewController *)<em>dvc</em> overlayViewsForPage:(NSUInteger)<em>page</em></code></div>
	
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>This method shall return a set of view to display over the pdf page.</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">FPKOverlayViewDataSource.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/documentViewController:rectForOverlayView:onPage:" title="documentViewController:rectForOverlayView:onPage:"></a>
	<h3 class="subsubtitle method-title">documentViewController:rectForOverlayView:onPage:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>This method needs to return the frame in page-coordinates for the view passed as arguments. Remember that, like drawables
and touchables, the coordinate system&rsquo;s origin is in the bottom left corner of the page.</p>
	</div>		
	
	
	<div class="method-subsection method-declaration"><code>- (CGRect)documentViewController:(MFDocumentViewController *)<em>dvc</em> rectForOverlayView:(UIView *)<em>view</em> onPage:(NSUInteger)<em>page</em></code></div>
	
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>This method needs to return the frame in page-coordinates for the view passed as arguments. Remember that, like drawables
and touchables, the coordinate system&rsquo;s origin is in the bottom left corner of the page.</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">FPKOverlayViewDataSource.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/documentViewController:willAddOverlayView:" title="documentViewController:willAddOverlayView:"></a>
	<h3 class="subsubtitle method-title">documentViewController:willAddOverlayView:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>These callbacks will be invoked when the overlay view is going to be added, after is added, when is going to be removed
and when it is actually removed from the page view. Use these to change the status of the view and or start/stop any
action that needs to be synchronized with the lifecycle of the view.</p>
	</div>		
	
	
	<div class="method-subsection method-declaration"><code>- (void)documentViewController:(MFDocumentViewController *)<em>dvc</em> willAddOverlayView:(UIView *)<em>view</em></code></div>
	
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>These callbacks will be invoked when the overlay view is going to be added, after is added, when is going to be removed
and when it is actually removed from the page view. Use these to change the status of the view and or start/stop any
action that needs to be synchronized with the lifecycle of the view.</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">FPKOverlayViewDataSource.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/documentViewController:willRemoveOverlayView:" title="documentViewController:willRemoveOverlayView:"></a>
	<h3 class="subsubtitle method-title">documentViewController:willRemoveOverlayView:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>This method is called when the Overlay View are going to be removed</p>
	</div>		
	
	
	<div class="method-subsection method-declaration"><code>- (void)documentViewController:(MFDocumentViewController *)<em>dvc</em> willRemoveOverlayView:(UIView *)<em>view</em></code></div>
	
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>This method is called when the Overlay View are going to be removed</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">FPKOverlayViewDataSource.h</code><br />
	</div>				
	
	
</div>
						
					</div>
					
					
				</div>
				<div class="main-navigation navigation-bottom">
					<ul>
	<li><a href="../index.html">Index</a></li>
	<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
				</div>
				<div id="footer">
					<hr />
					<div class="footer-copyright">
						<p><span class="copyright">&copy; 2012 MobFarm. All rights reserved. (Last updated: 2012-01-04)</span><br />
						
						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 748)</a>.</span></p>
						
					</div>
				</div>
			</div>
		</article>
		<script type="text/javascript">
			function jumpToChange()
			{
				window.location.hash = this.options[this.selectedIndex].value;
			}
			
			function toggleTOC()
			{
				var contents = document.getElementById('contents');
				var tocContainer = document.getElementById('tocContainer');
				
				if (this.getAttribute('class') == 'open')
				{
					this.setAttribute('class', '');
					contents.setAttribute('class', '');
					tocContainer.setAttribute('class', '');
					
					window.name = "hideTOC";
				}
				else
				{
					this.setAttribute('class', 'open');
					contents.setAttribute('class', 'isShowingTOC');
					tocContainer.setAttribute('class', 'isShowingTOC');
					
					window.name = "";
				}
				return false;
			}
			
			function toggleTOCEntryChildren(e)
			{
				e.stopPropagation();
				var currentClass = this.getAttribute('class');
				if (currentClass == 'children') {
					this.setAttribute('class', 'children open');
				}
				else if (currentClass == 'children open') {
					this.setAttribute('class', 'children');
				}
				return false;
			}
			
			function tocEntryClick(e)
			{
				e.stopPropagation();
				return true;
			}
			
			function init()
			{
				var selectElement = document.getElementById('jumpTo');
				selectElement.addEventListener('change', jumpToChange, false);
				
				var tocButton = document.getElementById('table_of_contents');
				tocButton.addEventListener('click', toggleTOC, false);
				
				var taskTreeItem = document.getElementById('task_treeitem');
				if (taskTreeItem.getElementsByTagName('li').length > 0)
				{
					taskTreeItem.setAttribute('class', 'children');
					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
				}
				
				var tocList = document.getElementById('toc');
				
				var tocEntries = tocList.getElementsByTagName('li');
				for (var i = 0; i < tocEntries.length; i++) {
					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
				}
				
				var tocLinks = tocList.getElementsByTagName('a');
				for (var i = 0; i < tocLinks.length; i++) {
					tocLinks[i].addEventListener('click', tocEntryClick, false);
				}
				
				if (window.name == "hideTOC") {
					toggleTOC.call(tocButton);
				}
			}
			
			window.onload = init;
		</script>
	</body>
</html>